﻿//
// MudTools.OfficeInterop 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

using System.Drawing;

namespace MudTools.OfficeInterop.Excel;

/// <summary>
/// Excel Interior 对象的二次封装接口
/// 提供对 Microsoft.Office.Interop.Excel.Interior 的安全访问和操作
/// </summary>
public interface IExcelInterior : IDisposable
{
    #region 基础属性

    /// <summary>
    /// 获取或设置内部颜色
    /// 对应 Interior.Color 属性
    /// </summary>
    Color Color { get; set; }

    /// <summary>
    /// 获取或设置内部图案类型
    /// 对应 Interior.Pattern 属性
    /// </summary>
    int Pattern { get; set; }

    /// <summary>
    /// 获取或设置内部颜色索引
    /// 对应 Interior.ColorIndex 属性
    /// </summary>
    XlColorIndex ColorIndex { get; set; }

    /// <summary>
    /// 获取或设置图案颜色
    /// 对应 Interior.PatternColor 属性
    /// </summary>
    Color PatternColor { get; set; }

    /// <summary>
    /// 获取或设置主题颜色
    /// 对应 Interior.ThemeColor 属性
    /// </summary>
    Color ThemeColor { get; set; }

    /// <summary>
    /// 获取或设置着色和阴影
    /// 对应 Interior.TintAndShade 属性
    /// </summary>
    double TintAndShade { get; set; }

    /// <summary>
    /// 获取或设置图案主题颜色
    /// 对应 Interior.PatternThemeColor 属性
    /// </summary>
    int PatternThemeColor { get; set; }

    /// <summary>
    /// 获取或设置图案着色和阴影
    /// 对应 Interior.PatternTintAndShade 属性
    /// </summary>
    double PatternTintAndShade { get; set; }

    /// <summary>
    /// 获取内部对象所在的父对象
    /// 对应 Interior.Parent 属性
    /// </summary>
    object Parent { get; }

    /// <summary>
    /// 获取内部对象所在的Application对象
    /// 对应 Interior.Application 属性
    /// </summary>
    IExcelApplication Application { get; }

    #endregion

    #region 格式设置
    /// <summary>
    /// 重置内部对象为默认值
    /// </summary>
    void Reset();

    /// <summary>
    /// 复制内部对象格式
    /// </summary>
    /// <param name="sourceInterior">源内部对象</param>
    void CopyFormat(IExcelInterior sourceInterior);

    /// <summary>
    /// 应用预设样式
    /// </summary>
    /// <param name="presetStyle">预设样式类型</param>
    void ApplyPresetStyle(int presetStyle);

    #endregion

    #region 导出和转换

    /// <summary>
    /// 导出内部对象到文件
    /// </summary>
    /// <param name="filename">导出文件路径</param>
    /// <param name="overwrite">是否覆盖已存在文件</param>
    /// <returns>是否导出成功</returns>
    bool Export(string filename, bool overwrite = true);

    #endregion

}